Skip to main content

Map Tenant To Service

PATCH /api/v1/tenants/:tenantId/services/:serviceId/map

Description

Map a tenant to a service with the specified configuration.

Request

  • Authentication:

    • Type: Bearer Token

    • Token: {{bearerToken}} (Replace with the actual bearer token)

  • Content-Type: application/json

  • URL:

    • Raw URL: /api/v1/tenants/:tenantId/services/:serviceId/map

    • Host:

    • Path: /api/v1/tenants/:tenantId/services/:serviceId/map

    • Variables:

      • tenantId: (Required)

      • serviceId: (Required)

Response:

  • Status: OK (200)
/api/v1/tenants/:tenantId/services/:serviceId/map

Headers

Content-TypeValue
Content-Typeapplication/json

Body (raw)

{
"userId": "<string>",
"config": [
{
"label": "<string>",
"key": "<string>",
"value": "<string>",
"required": "<boolean>",
"valueType": "array-alpha-numeric",
"formType": "input",
"formOptions": [
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
},
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
}
]
},
{
"label": "<string>",
"key": "<string>",
"value": "<string>",
"required": "<boolean>",
"valueType": "array-string",
"formType": "input",
"formOptions": [
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
},
{
"label": "<string>",
"value": "<string>",
"key": "<string>"
}
]
}
],
"actionBy": "<string>",
"apiKeyRotationPeriod": "WEEKS",
"apiKeyRotationValue": "<number>",
"apiKeyRotationCustomDate": {},
"callBackUrl": "<string>"
}

🔑 Authentication bearer

ParamvalueType
tokenbearerTokenstring

Response: 200

{
"message": "Tenant Service Mapping in progress, use apiKey to retrieve service key",
"apiDetails": {
"apiKey": "6c8ebb98-51d7-47af-a529-83dd3bce574d",
"apiCode": "operations"
}
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request PATCH \ 
--url /api/v1/tenants/:tenantId/services/:serviceId/map \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!